promotionalOfferSignatureV1

The promotional-offer signature you generate using an earlier signature version.

Declaration

object promotionalOfferSignatureV1

Properties

Name	Type	Description
`encodedSignature` Required	string	The Base64-encoded cryptographic signature you generate using the offer parameters.
`productId` Required	`productId`	The subscription’s product identifier.
`nonce` Required	uuid	A one-time-use UUID antireplay value you generate. Use lowercase.
`timestamp` Required	timestamp	The UNIX time, in milliseconds, when you generate the signature.
`keyId` Required	string	A string that identifies the private key you use to generate the signature. You can find this identifier in App Store Connect Users and Access > Keys in the Key ID column for the subscription key you generate.
`offerIdentifier` Required	string	The subscription offer identifier that you set up in App Store Connect.
`appAccountToken`	uuid	A UUID that you provide to associate with the transaction if the customer accepts the promotional offer. The string representation of the `appAccountToken` needs to be lowercase.

Discussion

To provide a promotional-offer retention message, you need to cryptographically sign the offer and include it in the promotionalOffer parameter of your RealtimeResponseBody response.

For instructions on generating the encodedSignature for the promotionalOfferSignatureV1, see Generating a signature for promotional offers.