Object

SubscriptionModifyInAppRequest

自動更新サブスクリプションに変更を加えるためにあなたのアプリが提供する要求データ。

Advanced Commerce API 1.0+

object SubscriptionModifyInAppRequest

プロパティ

addItems [SubscriptionModifyAdd Item]
changeItems [SubscriptionModify ChangeItem]
currency currency
descriptors SubscriptionModifyDescriptors
operation string	(必須) Value: MODIFY_SUBSCRIPTION
periodChange SubscriptionModify PeriodChange
removeItems [SubscriptionModify RemoveItem]
requestInfo RequestInfo	(必須)
retainBillingCycle retainBillingCycle	(必須)
storefront storefront
taxCode taxCode
transactionId transactionId	(必須)
version version	(必須)

議論

顧客がサブスクリプションにアップグレード、ダウングレード、アイテムの追加や削除などの 1 つ以上の変更を加えた場合は、あなたのアプリで SubscriptionModifyInAppRequest を使用して下さい。

例: サブスクリプションのアップグレード

以下の要求では、

顧客はサブスクリプションを月間サブスクリプションから年間サブスクリプションにアップグレードします。アップグレードは即時有効になります。

請求サイクルがリセットされます。

この例では、requestInfo にオプションのフィールドは含まれていません。

Request (要求)

{
    "operation": "MODIFY_SUBSCRIPTION",
    "version": "1",
    "transactionId": "12345",
    "requestInfo": {
        "requestReferenceId": "e2a88501-25ba-403a-9c46-d7b8eecc56ba"
    },
    "currency": "USD",
    "storefront": "USA",
    "descriptors": {
        "effective": "IMMEDIATELY",
        "displayName": "Anne's Game Stream",
        "description": "Streaming Service for Anne's Game"
    },
    "periodChange": {
        "effective": "IMMEDIATELY",
        "period": "P1Y"
    },
    "retainBillingCycle": false,
    "changeItems": [
        {
            "effective": "IMMEDIATELY",
            "currentSKU": "ANNES_GOLD_TIER_1M",
            "SKU": "ANNES_PLATINUM_TIER_1Y",
            "price": 99990,
            "displayName": "Platinum Tier",
            "description": "Access to Anne's Game Stream & chat",
            "reason": "UPGRADE"
        }
    ]
}

例: アイテムを追加して請求サイクルを維持

以下の要求では、

顧客がサブスクリプションにアイテムを追加すると、即時に有効になります。

請求サイクルは変わりません。顧客は新しいアイテムの按分価格を支払う必要があります。Apple は按分価格を計算し、顧客に支払い明細書を提示します。

要求の price フィールドと currency フィールドに示されている通り、顧客には次の通常請求期間に 4.99 米ドルが請求されます。

この例では、requestInfo にオプションのフィールドは含まれていません。

Request (要求)

{
    "operation": "MODIFY_SUBSCRIPTION",
    "version": "1",
    "transactionId": "12345",
    "requestInfo": {
        "requestReferenceId": "e2a88501-25ba-403a-9c46-d7b8eecc56ba"
    },
    "currency": "USD",
    "storefront": "USA",
    "descriptors": {
        "effective": "IMMEDIATELY",
        "displayName": "Streaming Pass",
        "description": "Streaming pass with multiple items"
    },
    "retainBillingCycle": true,
    "addItems": [
        {
            "SKU": "NEWS_CHANNELS",
            "displayName": "News Channel",
            "description": "Access to news channels",
            "price": 4990
        }
    ]
}

例: 次回の更新時にアイテムを削除

以下の要求では、

顧客がサブスクリプションからアイテムを削除した場合、次回の更新時にそのアイテムが削除されます。

請求サイクルは変わりません。

残りのアイテムは次回の請求期間に更新されます。

この例では、requestInfo にオプションのフィールドは含まれていません。

Request (要求)

{
    "operation": "MODIFY_SUBSCRIPTION",
    "version": "1",
    "transactionId": "12345",
    "requestInfo": {
        "requestReferenceId": "e2a88501-25ba-403a-9c46-d7b8eecc56ba"
    },
    "currency": "USD",
    "storefront": "USA",
    "retainBillingCycle": true,
    "removeItems": [
        {
            "SKU": "LIVE_SPORTS"
        }
    ]
}

例: 次回の更新時にサブスクリプションをダウングレードする

以下の要求では、

顧客はサブスクリプションをダウングレードします。これは次回の更新時に有効になります。

請求サイクルは同じままです。

この例では、requestInfo にオプションのフィールドは含まれていません。

Request (要求)

{
    "operation": "MODIFY_SUBSCRIPTION",
    "version": "1",
    "transactionId": "12345",
    "requestInfo": {
        "requestReferenceId": "e2a88501-25ba-403a-9c46-d7b8eecc56ba"
    },
    "currency": "USD",
    "storefront": "USA",
    "descriptors": {
        "effective": "NEXT_BILL_CYCLE",
        "displayName": "Anne's Game Stream",
        "description": "Streaming Service for Anne’s Game"
    },
    "retainBillingCycle": true,
    "changeItems": [
        {
            "effective": "NEXT_BILL_CYCLE",
            "currentSKU": "ANNES_PLATINUM_TIER_1M",
            "SKU": "ANNES_GOLD_TIER_1M",
            "price": 7990,
            "displayName": "Gold Tier",
            "description": "Access to Anne's Game Stream",
            "reason": "DOWNGRADE"
        }
    ]
}