Web Service Endpoint


サブスクリプション更新日を延長する


元の取引 ID を使用して、顧客のアクティブなサブスクリプションの更新日を延長します。


App Store Server API 1.1+





URL


PUT https://api.storekit.itunes.apple.com/inApps/v1/subscriptions/extend/{originalTransactionId}

Sandbox URL


PUT https://api.storekit-sandbox.itunes.apple.com/inApps/v1/subscriptions/extend/{originalTransactionId}

パスパラメータ


originalTransactionId
originalTransactionId
(必須)更新日延長を受け取るサブスクリプションの元の取引 ID。

HTTP 本体


ExtendRenewalDate
Request
サブスクリプション更新延長データを含む要求本文。
Content-Type: application/json
400
(InvalidOriginal
TransactionIdError
| InvalidExtendByDays
Error
| InvalidExtend
ReasonCodeError
| InvalidRequest
IdentifierError
)
不正な要求
要求は無効であり、受け付けられません。
Content-Type: application/json
401不正
認証ヘッダ内の JSON Web Token(JWT)が無効です。詳しくは、API 要求用の JSON Web トークンの生成 をご覧ください。
403
(SubscriptionExtension
IneligibleError
| SubscriptionMax
ExtensionError
| Family
SharedSubscription
ExtensionIneligible
Error
)
禁止
要求は無効であり、受け付けられません。
Content-Type: application/json
404
OriginalTransactionId
NotFoundError
見つからない
要求は無効であり、受け付けられません。
Content-Type: application/json
429
RateLimitExceededError
要求がレート制限を超えました。
Content-Type: application/json
500
(GeneralInternalError | GeneralInternal
RetryableError
)
内部サーバーエラー
要求が失敗しました。一時的な障害が原因である可能性があります。詳細については、特定のエラーメッセージをご確認ください。
Content-Type: application/json

以下で言及


自動更新サブスクリプションの更新日を延長


App Store サーバ API の変更履歴


レート制限の識別



議論


このエンドポイントを使用すると、一時的なサービス停止、イベントのキャンセル、ライブストリーミングイベントの中断などが発生した場合に、顧客達の有料のアクティブなサブスクリプションの更新日を延長することで補償することができます。このエンドポイントは、あなたが指定した取引 ID の単一のサブスクリプションに対して機能します。


このエンドポイントを呼び出すには、サービス中断が発生したサブスクリプションの元の取引 ID を指定してください。要求本体(ExtendRenewalDateRequest)には、延長期間、延長理由コード、および各延長要求の一意の requestIdentifier を指定してください。


このエンドポイントが家族間共有に対応する購入済みのサブスクリプションを延長すると、家族メンバーのサブスクリプションも自動的に延長されます。ただし、このエンドポイントは家族メンバーのサブスクリプションを直接延長する要求をサポートしていません。


HTTP 200 ステータスコードで成功した応答には、ExtendRenewalDateResponse オブジェクトが含まれます。応答オブジェクトには、要求であなたが指定したのと同じ一意の要求 ID と、延長が成功したかどうかを判断するために必要な情報が含まれます。延長が成功した場合、新しいサブスクリプションの有効期限は effectiveDate になります。HTTP 200 以外の全てのステータスコードは、要求が失敗したことを示します。


注意

サブスクリプション更新の延長が有効になると、元に戻すことはできません。App Store が開発者の手数料率を計算する際、延長期間は 1 年間の有料サービス期間にはカウントされません。

更新日延長が成功すると、Apple は顧客に更新されたサブスクリプション更新日をお知らせするメールを送信します。


このエンドポイントと、サブスクリプションの資格を含む関連エンドポイントの詳細については、自動更新サブスクリプションの更新日を延長 をご覧ください。





以下も見よ


サブスクリプション更新日の延長


自動更新サブスクリプションの更新日を延長

サブスクリプションの更新日を延長することで、対象となるアクティブな加入者のサービス中断を補償します。


すべてのアクティブな加入者のサブスクリプション更新日を延長

サブスクリプションの製品 ID を使用して、対象となるアクティブな加入者全員の更新日を延長します。


サブスクリプション更新日延長のステータスを取得する

更新日延長要求が完了したかどうかを確認し、成功または失敗した延長の最終件数を提供します。


object ExtendRenewalDateRequest

個々のサブスクリプションのサブスクリプション更新延長データが含まれる要求本文。


object ExtendRenewalDateResponse

個々の更新日延長が成功したかどうか、および関連する詳細を示す応答。


object MassExtendRenewalDateRequest

すべての対象となるアクティブな加入者に適用するサブスクリプション更新延長データを含む要求本文。


object MassExtendRenewalDateResponse

サーバーがサブスクリプション更新日延長要求を正常に受信したことを示す応答。


object MassExtendRenewalDateStatusResponse

すべての対象加入者に対してサブスクリプションの更新日を延長する要求の現在のステータスを示す応答。














トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ