Web サービスエンドポイント


サブスクリプションを取り消す


顧客のサブスクリプションとそれに含まれるすべてのアイテムを直ちにキャンセルし、全額または日割り計算による払い戻しを要求します。


Advanced Commerce API 1.0+




URL


POST https://api.storekit.itunes.apple.com/advancedCommerce/v1/subscription/revoke/{transactionId}


サンドボックス URL


POST https://api.storekit-sandbox.itunes.apple.com/advancedCommerce/v1/subscription/revoke/{transactionId}


パスパラメータ


transactionId
string		(必須)取り消す自動更新サブスクリプションの取引 ID。サブスクリプションの元の 取引 ID、またはサブスクリプションに関連する取引のそれ以降の取引 ID を使用して下さい。


HTTP 本体


SubscriptionRevoke
Request		Content-Type: application/json

応答コード


200
SubscriptionRevoke
Response		OK
要求は成功しました。
Content-Type: application/json
400
(RepeatedRequest
ReferenceIdError |
NullRequestInfo
Error | InvalidApp
AccountTokenError
| NullRequest
ReferenceIDError |
InvalidRequest
ReferenceIDError |
InvalidConsistency
TokenError |
InvalidStorefront
Error | Mismatched
StorefrontError |
Mismatched
StorefrontError |
OperationNot
AllowedError |
MalformedPayload
Error | Simulate
RefundDeclineOnly
InSandboxError |
RefundAmount
WithoutCustomError
| NullRefund
RiskingError |
Invalid
RefundTypeError
| Invalid
RefundReasonError
| NegativeRefund
AmountError | Null
RefundAmountError
| NullRefundReason
Error | NullRefund
TypeError |
PendingRefundError
| RevokeOnInactive
SubscriptionError)		不正な要求です
Content-Type: application/json
401許可されていません
認証ヘッダー内の JSON Web Token (JWT) が無効です。詳細については、あなたのサーバーからの API 要求の承認 をご覧ください。
403
(SubscriptionDoesNot
ExistError | SubscriptionNot
EligibleError | ProductNotOwned
Error |
InsufficientFunds
Error | Already
RefundedError | TransactionNot
RefundableError)		禁止されている
Content-Type: application/json
404
TransactionIdNotFound
Error 		見つからない
Content-Type: application/json
429
RateLimitExceeded
Error		要求がレート制限を超えました。詳細については、Advanced Commerce API のレート制限の特定 をご覧ください。
Content-Type: application/json
500
(GeneralInternalError | GeneralInternal
RetryableError)		内部サーバーエラー
サーバーエラーです。後で再度試して下さい。
Content-Type: application/json

以下で言及


Advanced Commerce API の変更履歴


あなたのサーバーからの API 要求の承認


Advanced Commerce API のレート制限の特定



議論


このエンドポイントが成功すると、システムはサブスクリプションの自動更新ステータスを false に設定し、全額または日割り計算による払い戻しを行ってサブスクリプションを取り消します。App Store Server Notifications は、あなたの App Store Server Notifications V2 エンドポイントに REFUND notificationType を送信します。通知の JWSTransactionDecodedPayload 内の revocationDate プロパティを確認してください。取り消し日をもって、サブスクリプションとそのアイテムのサービスをオフにしてください。あなたが通知を受信するまで、サブスクリプションのサービスをオフにしないでください。


現在の期間の終了時にサブスクリプションをキャンセルするには、サブスクリプションのキャンセル を参照してください。


注意

サブスクリプションを取り消す エンドポイントを使用するには、メンバーシップアカウント所有者が Advanced Commerce API 補足契約に署名し、特定の資格要件を満たしていなければなりません。詳しくは、Advanced Commerce API をご覧ください。この契約の最新バージョンがまだ承認されていない場合、このエンドポイントを呼び出すことはできず、エラーが返されます。


サブスクリプションのキャンセル、サブスクリプションを取り消す、および 取引の払い戻しを要求する API の使用例については、Advanced Commerce API 補足資料を参照してください。




以下も見よ


サーバーからのサブスクリプションの取り消し


object SubscriptionRevokeRequest

サブスクリプションとそのすべてのアイテムを直ちに終了するためにあなたが提供する要求本文。


object SubscriptionRevokeResponse

サブスクリプション取り消し要求が成功した場合の応答本文。














トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ