Contents

responseBodyV2DecodedPayload

A decoded payload that contains the version 2 notification data.

Declaration

object responseBodyV2DecodedPayload

Properties

NameTypeDescription
notificationTypenotificationType

The in-app purchase event for which the App Store sends this version 2 notification.

subtypesubtype

Additional information that identifies the notification event. The subtype field is present only for specific version 2 notifications.

datadata

The object that contains the app metadata and signed renewal and transaction information.

The data, appData, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.

summarysummary

The summary data that appears when the App Store server completes your request to extend a subscription renewal date for eligible subscribers. For more information, see Extend Subscription Renewal Dates for All Active Subscribers.

The data, appData, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.

externalPurchaseTokenexternalPurchaseToken

This field appears when the notificationType is EXTERNAL_PURCHASE_TOKEN.

The data, appData, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.

appDataappData

The object that contains the app metadata and signed app transaction information. This field appears when the notificationType is RESCIND_CONSENT.

The data, appData, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.

versionversion

The App Store Server Notification version number, "2.0".

signedDatesignedDate

The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.

notificationUUIDnotificationUUID

A unique identifier for the notification. Use this value to identify a duplicate notification.

Mentioned in

Discussion

The responseBodyV2DecodedPayload is the Base64URL-decoded notification information from the JWS payload portion of the signedPayload. Use the notificationType and subtype to understand the event that led to this notification.

The payload can contain only one of the following four fields:

  • A data object, which contains details including the environment, the app metadata, and the signed transaction and subscription renewal information.

  • An appData object, which contains details including the environment, the app metadata, and the signed app transaction information.

  • A summary object, which contains information only when the notification is a RENEWAL_EXTENSION with a SUMMARY subtype. For more information, see Extend Subscription Renewal Dates for All Active Subscribers.

  • An externalPurchaseToken object, which contains an external purchase token only when the notification is EXTERNAL_PURCHASE_TOKEN. For more information about this notification, see externalPurchaseToken.

Topics

Response objects for in-app purchases

Response object for an external purchase

Response types

JWS header and payload data types

See Also

Server notifications version 2