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

サブスクリプションのキャンセル

自動更新をオフにして、顧客の自動更新サブスクリプションをキャンセルします。

Advanced Commerce API 1.0+

URL

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

サンドボックス URL

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

パスパラメータ

transactionId
string

(必須)キャンセルすべき自動更新サブスクリプションの取引 ID。

HTTP 本体

SubscriptionCancel
Request

キャンセルすべきサブスクリプションの情報を含む要求本文。
Content-Type: application/json

応答コード

200 SubscriptionCancel Response	OK 成功 Content-Type: application/json
400 (NullRequestInfoError \| InvalidAppAccountToken Error \| NullRequest ReferenceIDError \| InvalidRequestReference IDError \| Invalid ConsistencyTokenError \| InvalidStorefrontError \| MismatchedStorefront Error \| OperationNot AllowedError \| MalformedPayloadError)	不正な要求です Content-Type: application/json
401	許可されていません
403 (SubscriptionDoesNot ExistError \| SubscriptionNotEligible Error \| ProductNotOwned Error)	禁止されている Content-Type: application/json
404 TransactionIdNotFound Error	見つからない Content-Type: application/json
429	RateLimitExceededError Content-Type: application/json
500 (GeneralInternalError \| GeneralInternal RetryableError)	内部サーバーエラーです Content-Type: application/json

以下で言及

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

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

議論

このエンドポイントが成功すると、システムはサブスクリプションの自動更新ステータスを false に設定し、サブスクリプションは次の更新期間に更新されません。顧客は現在の期間の終了までサブスクリプションに引き続きアクセスできます。

サブスクリプションを直ちにキャンセルするには、サブスクリプションを取り消す をご覧ください。

注意

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

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

要求と応答の例

要求

応答 (復号された署名済み取引)

応答 (復号された署名済み更新情報)

{
    "requestInfo": {
        "requestReferenceId": "932c6903-0ab8-4469-9f21-015f6fab013c"
    },
    "storefront": "USA"
}

応答 (復号された署名済み取引)

{
    "transactionId": "12345",
    "originalTransactionId": "12345",
    "webOrderLineItemId": "23456",
    "bundleId": "com.example",
    "productId": "com.example.base",
    "subscriptionGroupIdentifier": "34567",
    "purchaseDate": 1735718400000,
    "originalPurchaseDate": 1735718400000,
    "expiresDate": 1738396800000,
    "quantity": 1,
    "type": "Auto-Renewable Subscription",
    "inAppOwnershipType": "PURCHASED",
    "signedDate": 1735718400000,
    "environment": "Production",
    "transactionReason": "PURCHASE",
    "storefront": "USA",
    "storefrontId": "143441",
    "price": 12980,
    "currency": "USD",
    "appTransactionId": "45678",
    "appAccountToken": "3152947d-8f63-41c2-9a91-e92e45f145e9",
    "advancedCommerceInfo": {
        "estimatedTax": 0,
        "taxRate": "0",
        "taxCode": "C003-00-1",
        "taxExclusivePrice": 12980,
        "descriptors": {
            "displayName": "Ad-free and advanced feature package",
            "description": "Remove ads and unlock advanced features."
        },
        "items": [
            {
                "SKU": "AD_FREE_1M",
                "displayName": "Ad-free monthly plan",
                "description": "Remove ads for the service.",
                "price": 9990
            },
            {
                "SKU": "ADVANCED_FEATURES_1M",
                "displayName": "Advanced feature monthly plan",
                "description": "Unlock advanced features for the month.",
                "price": 3990,
                "offer": {
                    "price": 2990,
                    "period": "P1M",
                    "periodCount": 3,
                    "reason": "ACQUISITION"
                }
            }
        ],
        "requestReferenceId": "932c6903-0ab8-4469-9f21-015f6fab013c",
        "period": "P1M"
    }
}

応答 (復号された署名済み更新情報)

{
    "originalTransactionId": "12345",
    "autoRenewProductId": "com.example.base",
    "productId": "com.example.base",
    "autoRenewStatus": 0,
    "signedDate": 1735718400000,
    "environment": "Production",
    "recentSubscriptionStartDate": 1735718400000,
    "renewalDate": 1738396800000,
    "advancedCommerceInfo": {
        "taxCode": "C003-00-1",
        "descriptors": {
            "displayName": "Ad-free and advanced feature package",
            "description": "Remove ads and unlock advanced features."
        },
        "items": [
            {
                "SKU": "AD_FREE_1M",
                "displayName": "Ad-free monthly plan",
                "description": "Remove ads for the service.",
                "price": 9990
            },
            {
                "SKU": "ADVANCED_FEATURES_1M",
                "displayName": "Advanced feature monthly plan",
                "description": "Unlock advanced features for the month.",
                "price": 3990,
                "offer": {
                    "price": 2990,
                    "period": "P1M",
                    "periodCount": 2,
                    "reason": "ACQUISITION"
                }
            }
        ],
        "requestReferenceId": "932c6903-0ab8-4469-9f21-015f6fab013c",
        "consistencyToken": "1.12345.932c6903-0ab8-4469-9f21-015f6fab013c",
        "period": "P1M"
    },
    "appTransactionId": "45678",
    "appAccountToken": "3152947d-8f63-41c2-9a91-e92e45f145e9"
}

以下も見よ

サーバーからのサブスクリプションのキャンセル

object SubscriptionCancelRequest

サブスクリプションの自動更新をオフにするための要求本文。

object SubscriptionCancelResponse

サブスクリプションのキャンセルが成功した場合の応答本文。

トップへ

トップへ

トップへ

トップへ

トップへ

トップへ

トップへ

XCode 16.3 日本語化計画