subtype
A string that provides details about select notification types in version 2.
Declaration
string subtypePossible Values
ACCEPTEDApplies to the
PRICE_INCREASEnotificationType. A notification with this subtype indicates that the customer consented to the subscription price increase if the price increase requires customer consent, or that the system notified them of a price increase if the price increase doesn’t require customer consent.ACTIVE_TOKEN_REMINDERApplies to the
EXTERNAL_PURCHASE_TOKENnotificationType. A notification with this subtype is a reminder that Apple created a custom link external purchase token for your app, and the token is still active. App Store Server sends this notification monthly while the token is active, unless you report the token as a duplicate. For information about reporting tokens, see externalPurchaseToken.AUTO_RENEW_DISABLEDApplies to the
DID_CHANGE_RENEWAL_STATUSnotificationType. A notification with this subtype indicates that the customer turned off subscription auto-renewal, or the App Store turned off subscription auto-renewal after the customer requested a refund.AUTO_RENEW_ENABLEDApplies to the
DID_CHANGE_RENEWAL_STATUSnotificationType. A notification with this subtype indicates that the customer enabled subscription auto-renewal.BILLING_RECOVERYApplies to the
DID_RENEWnotificationType. A notification with this subtype indicates that the expired subscription that previously failed to renew has successfully renewed.BILLING_RETRYApplies to the EXPIRED notificationType. A notification with this subtype indicates that the subscription expired because the subscription failed to renew before the billing retry period ended.
CREATEDApplies to the
EXTERNAL_PURCHASE_TOKENnotificationType. A notification with this subtype indicates that Apple created a custom link token for your app. For more information about custom link tokens, see Receiving and decoding external purchase tokens.DOWNGRADEApplies to the
DID_CHANGE_RENEWAL_PREFandOFFER_REDEEMEDnotificationType. A notification with this subtype indicates that the customer downgraded their subscription or cross-graded to a subscription with a different duration. Downgrades take effect at the next renewal date.FAILUREApplies to the
RENEWAL_EXTENSIONnotificationType. A notification with thissubtypeindicates that the subscription-renewal-date extension failed for an individual subscription. For details, see the data object in the responseBodyV2DecodedPayload. For information on the request, see Extend Subscription Renewal Dates for All Active Subscribers.GRACE_PERIODApplies to the
DID_FAIL_TO_RENEWnotificationType. A notification with this subtype indicates that the subscription failed to renew due to a billing issue. Continue to provide access to the subscription during the grace period.INITIAL_BUYApplies to the
SUBSCRIBEDnotificationType. A notification with thissubtypeindicates that the customer purchased the subscription for the first time or that the customer received access to the subscription through Family Sharing for the first time.PENDINGApplies to the
PRICE_INCREASEnotificationType. A notification with thissubtypeindicates that the system informed the customer of the subscription price increase, but the customer hasn’t accepted it.PRICE_INCREASEApplies to the
EXPIREDnotificationType. A notification with thissubtypeindicates that the subscription expired because the customer didn’t consent to a price increase.PRODUCT_NOT_FOR_SALEApplies to the
EXPIREDnotificationType. A notification with thissubtypeindicates that the subscription expired because the product wasn’t available for purchase at the time the subscription attempted to renew.RESUBSCRIBEApplies to the
SUBSCRIBEDnotificationType. A notification with thissubtypeindicates that the customer resubscribed or received access through Family Sharing to the same subscription or to another subscription within the same subscription group.SUMMARYApplies to the
RENEWAL_EXTENSIONnotificationType. A notification with this subtype indicates that the App Store server completed your request to extend the subscription renewal date for all eligible subscribers. For the summary details, see the summary object in the responseBodyV2DecodedPayload. For information on the request, see Extend Subscription Renewal Dates for All Active Subscribers.UPGRADEApplies to the
DID_CHANGE_RENEWAL_PREFandOFFER_REDEEMEDnotificationType. A notification with thissubtypeindicates that the customer upgraded their subscription or cross-graded to a subscription with the same duration. Upgrades take effect immediately.UNREPORTEDApplies to the
EXTERNAL_PURCHASE_TOKENnotificationType. A notification with thissubtypeindicates that Apple created a token for your app but didn’t receive a report. For more information about reporting the token, see externalPurchaseToken.VOLUNTARYApplies to the
EXPIREDnotificationType. A notification with this subtype indicates that the subscription expired after the customer turned off subscription auto-renewal.
Mentioned in
Discussion
This subtype field is part of the responseBodyV2DecodedPayload, and further describes an event of type notificationType. It’s present only for specific version 2 notifications.