Web Service Endpoint

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

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

App Store Server API 1.1+

object summary

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 Body

ExtendRenewalDate
Request

サブスクリプション更新延長データを含む要求本文。
Content-Type: application/json

反応コード

200 object ExtendRenewalDate Response	OK 要求は成功した Content-Type: application/json
400 (InvalidOriginal TransactionIdError \| InvalidExtendByDaysError \| InvalidExtendReason CodeError \| Invalid RequestIdentifierError)	不正な要求要求は無効であるため、承認できません。
401	認証されていません認証ヘッダ内の JSON Web Token (JWT) が無効です。詳細については、API 要求用の JSON Web トークンの生成を参照して下さい。
403 (SubscriptionExtension IneligibleError \| SubscriptionMaxExtension Error \| FamilyShared SubscriptionExtension IneligibleError)	禁止要求は無効であるため、承認できません。 Content-Type: application/json
404 OriginalTransactionIdNot FoundError	見つからない要求は無効であるため、承認できません。 Content-Type: application/json
429 RateLimitExceededError	要求がレート制限を超えました。 Content-Type: application/json
500 (GeneralInternalError \| GeneralInternalRetryable Error)	内部サーバエラー要求が失敗しました。一時的な障害が原因かもしれません。詳細については、特定のエラーメッセージをご確認ください。 Content-Type: application/json

以下で言及

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

App Store サーバ API の変更履歴

レート制限の識別

議論

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

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

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

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