Contents

data

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

Declaration

object data

Properties

NameTypeDescription
appAppleIdappAppleId

The unique identifier of the app that the notification applies to. This property is available for apps that users download from the App Store. It isn’t present in the sandbox environment.

bundleIdbundleId

The bundle identifier of the app.

bundleVersionbundleVersion

The version of the build that identifies an iteration of the bundle.

consumptionRequestReasonconsumptionRequestReason

The reason the customer requested the refund. This field appears only for CONSUMPTION_REQUEST notifications, which the server sends when a customer initiates a refund request for a consumable in-app purchase or auto-renewable subscription.

environmentenvironment

The server environment that the notification applies to, either sandbox or production.

signedRenewalInfoJWSRenewalInfo

Subscription renewal information signed by the App Store, in JSON Web Signature (JWS) format. This field appears only for notifications that apply to auto-renewable subscriptions.

signedTransactionInfoJWSTransaction

Transaction information signed by the App Store, in JSON Web Signature (JWS) format.

statusstatus

The status of an auto-renewable subscription as of the signedDate in the responseBodyV2DecodedPayload. This field appears only for notifications sent for auto-renewable subscriptions.

Mentioned in

Discussion

The data object is part of the responseBodyV2DecodedPayload. It’s present in the payload for notificationType values related to in-app purchases, except for the RENEWAL_EXTENSION notification type with a SUMMARY subtype, and the EXTERNAL_PURCHASE_TOKEN notification type.

Use the notification type along with the transaction and subscription renewal information in the data object to update a user’s service or present promotional offers according to your business logic.

Topics

App metadata and environment

JWS transaction and renewal info

Consumption request info

See Also

Response objects for in-app purchases