List Apple retention messages and offers
list_retention_messagesRead, live from App Store Connect, the app's Apple retention messages (what a subscriber sees when they start to cancel): versions with their App Review state (PREPARE_FOR_SUBMISSION, WAITING_FOR_REVIEW, IN_REVIEW, APPROVED, REJECTED…), per-locale header and body, image, attached subscriptions; and each subscription with its current message and retention offers (duration, mode, minimum paid months, months between offers, number of territories, presented with the message or not). rules repeats Apple's limits; an offer requires a minimum paid duration, so people in a free trial are not eligible. retentionOfferId reads that offer's price per territory instead.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"appId": "<appId>"
},
"name": "list_retention_messages"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes | ||
| retentionOfferId | No |